﻿/*----------------------------------------------------------------
//  <copyright file="BasicAuthAuthorizationFilterOptions.cs" company="MicroCloud@151504200868">
//      Copyright © 2020-2024 MicroCloud Corporation, All rights reserved.
//  </copyright>
//  <site>https://gitee.com/chenmm123/microclouds</site>
//  <last-editor>cmm</last-editor>
//  <last-date>2024-03-04 14:50</last-date>
//----------------------------------------------------------------*/

namespace MicroCloud.Hangfire.Dashboard.Authorization
{
    #region "表示Hangfire基本身份验证的选项"
    /// <summary>
    /// 表示Hangfire基本身份验证的选项
    /// （Represents options for Hangfire basic authentication）
    /// </summary>
    public class BasicAuthAuthorizationFilterOptions
    {
        #region "属性"
        #region "获取或设置 SSL重定向"
        /// <summary>
        /// 获取或设置 SSL重定向
        /// </summary>
        public bool SslRedirect { get; set; }
        #endregion
        #region "获取或设置 需要SSL连接才能访问Hangfire Dashboard"
        /// <summary>
        /// 获取或设置 需要SSL连接才能访问Hangfire Dashboard。强烈建议在使用基本身份验证时使用SSL。
        /// </summary>
        public bool RequireSsl { get; set; }
        #endregion
        #region "获取或设置 登录检查是否区分大小写"
        /// <summary>
        /// 获取或设置 登录检查是否区分大小写
        /// </summary>
        public bool LoginCaseSensitive { get; set; }
        #endregion
        #region "获取或设置 表示访问Hangfire仪表板的用户列表"
        /// <summary>
        /// 获取或设置 表示访问Hangfire仪表板的用户列表
        /// </summary>
        public IEnumerable<BasicAuthAuthorizationUser> Users { get; set; }
        #endregion

        #endregion
        #region "构造函数"
        #region "初始化一个Hangfire基本身份验证的选项的新实例"
        /// <summary>
        /// 初始化一个Hangfire基本身份验证的选项 <see cref="BasicAuthAuthorizationFilterOptions"/> 的新实例
        /// </summary>
        public BasicAuthAuthorizationFilterOptions()
        {
            SslRedirect = false;
            RequireSsl = false;
            LoginCaseSensitive = false;
            Users = Array.Empty<BasicAuthAuthorizationUser>();
        }
        #endregion

        #endregion

    }
    #endregion

}
